POST api/audit/{authenticationToken}/{loanKey}

This method returns the audit information about a specific field on a loan.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authenticationToken

string

Required

loanKey

The loan key string identifying the loan whose audit information will be returned

string

Required

Body Parameters

This field is used to identify the field and optional key information for the request

AuditKeyModel
NameDescriptionTypeAdditional information
Alias

This field is the alias of the field for which audit information is being requested.

string

None.

KeyData

If the type of information is detail specific (only Customer is available at this time), then this is the key string for the information being requested. In the case of type Customer, then this is the customer key.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Alias": "sample string 1",
  "KeyData": "sample string 2"
}

application/xml, text/xml

Sample:
<AuditKeyModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <Alias>sample string 1</Alias>
  <KeyData>sample string 2</KeyData>
</AuditKeyModel>

application/x-www-form-urlencoded

Sample:
Alias=value&KeyData=value

Response Information

Resource Description

This returns the complete list of field auditing information for the specified field

Collection of AuditModel
NameDescriptionTypeAdditional information
ChangeDateTime

This field is the date and time the field was modified.

date

None.

Action

This field is the action that occurred. Possible actions are Change, Add, Delete, and Initial (used when adding a new field to be audited)

string

None.

UserName

This is the name of the person who modified the field.

string

None.

Value

This is the value of the field at the time the action occurred.

string

None.

FeeNumber

If the audited field is a fee, then this number is the number of the fee that was modified.

string

None.

AffectedUser

If the audited field is of type Setups and the data is system user related, then this is the user modified.

string

None.

AffectedGroup

If the audited field is of type Setups and the data is security group related, then this is the security group modified.

string

None.

AffectedCustomer

If the audited field is of type Customer, then this is the borrower on the loan that was modified.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ChangeDateTime": "2025-07-07T05:34:50.8133114-05:00",
    "Action": "sample string 2",
    "UserName": "sample string 3",
    "Value": "sample string 4",
    "FeeNumber": "sample string 5",
    "AffectedUser": "sample string 6",
    "AffectedGroup": "sample string 7",
    "AffectedCustomer": "sample string 8"
  },
  {
    "ChangeDateTime": "2025-07-07T05:34:50.8133114-05:00",
    "Action": "sample string 2",
    "UserName": "sample string 3",
    "Value": "sample string 4",
    "FeeNumber": "sample string 5",
    "AffectedUser": "sample string 6",
    "AffectedGroup": "sample string 7",
    "AffectedCustomer": "sample string 8"
  }
]

application/xml, text/xml

Sample:
<ArrayOfAuditModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EpicAPI.Models">
  <AuditModel>
    <Action>sample string 2</Action>
    <AffectedCustomer>sample string 8</AffectedCustomer>
    <AffectedGroup>sample string 7</AffectedGroup>
    <AffectedUser>sample string 6</AffectedUser>
    <ChangeDateTime>2025-07-07T05:34:50.8133114-05:00</ChangeDateTime>
    <FeeNumber>sample string 5</FeeNumber>
    <UserName>sample string 3</UserName>
    <Value>sample string 4</Value>
  </AuditModel>
  <AuditModel>
    <Action>sample string 2</Action>
    <AffectedCustomer>sample string 8</AffectedCustomer>
    <AffectedGroup>sample string 7</AffectedGroup>
    <AffectedUser>sample string 6</AffectedUser>
    <ChangeDateTime>2025-07-07T05:34:50.8133114-05:00</ChangeDateTime>
    <FeeNumber>sample string 5</FeeNumber>
    <UserName>sample string 3</UserName>
    <Value>sample string 4</Value>
  </AuditModel>
</ArrayOfAuditModel>